<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>flickr.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
       <span class="fn">flickr.js</span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    <span class='nodesc'>No description.</span>
  </div>
  

        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="local_closure_goog_ui_media_flickr.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
            <li><a href="http://code.google.com/p/closure-library/source/browse/local/closure/goog/ui/media/flickr.js">Git</a></li>
          </ol>
        </div>
</div>

<h2 class="g-first">File Location</h2>
  <div class="g-section g-tpl-20-80">
    <div class="g-unit g-first">
      <div class="g-c-cell code-label">/goog/ui/media/flickr.js</div>
    </div>
  </div>
<hr/>


  <h2>Classes</h2>
 <div class="fn-constructor">
        <a href="class_goog_ui_media_FlickrSet.html">
          goog.ui.media.FlickrSet</a><br/>
        <div class="class-details">Subclasses a goog.ui.media.MediaRenderer to provide a FlickrSet specific
media renderer.

This class knows how to parse FlickrSet URLs, and render the DOM structure
of flickr set players. This class is meant to be used as a singleton static
stateless class, that takes <code> goog.ui.media.Media</code> instances and renders
it. It expects <code> goog.ui.media.Media.getModel</code> to return a well formed,
previously constructed, set id ,
which is the data model this renderer will use to construct the DOM
structure.  for a example of
constructing a control with this renderer.

This design is patterned after
<a href="http://go/closure_control_subclassing">http://go/closure_control_subclassing</a>

It uses <code> goog.ui.media.FlashObject</code> to embed the flash object.

</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_ui_media_FlickrSetModel.html">
          goog.ui.media.FlickrSetModel</a><br/>
        <div class="class-details">The <code> goog.ui.media.FlickrAlbum</code> media data model. It stores a required
<code> userId</code> and <code> setId</code> fields, sets the flickr Set URL, and
allows a few optional parameters.

</div>
 </div>
      
<br/>

  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>




  <h2>Global Functions</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.media.FlickrSetModel.buildUrl"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.media.FlickrSetModel.</span><span class="entryName">buildUrl<span class="args">(<span class="arg">userId</span>,&nbsp;<span class="arg">setId</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
      </div>


     <div class="entryOverview">
       Takes a flickr username and set id and returns an URL.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">userId</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">The owner of the set.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">setId</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">The set id.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>&nbsp;
            The URL of the set.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_media_flickr.js.source.html#line290">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.media.FlickrSet.getInstance"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.media.FlickrSet.</span><span class="entryName">getInstance<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_media_flickr.js.source.html#line94">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.media.FlickrSet.newControl"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.media.FlickrSet.</span><span class="entryName">newControl<span class="args">(<span class="arg">dataModel</span>,&nbsp;<span class="arg">opt_domHelper</span>)</span>
        </span>
        &#8658; <span class="type"><a href="class_goog_ui_media_Media.html">goog.ui.media.Media</a></span>
      </div>


     <div class="entryOverview">
       A static convenient method to construct a goog.ui.media.Media control out of
a FlickrSet URL. It extracts the set id information on the URL, sets it
as the data model goog.ui.media.FlickrSet renderer uses, sets the states
supported by the renderer, and returns a Control that binds everything
together. This is what you should be using for constructing FlickrSet videos,
except if you need more fine control over the configuration.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">dataModel</span>
        : <span class="type"><a href="class_goog_ui_media_FlickrSetModel.html">goog.ui.media.FlickrSetModel</a></span>
        <div class="entryOverview">The Flickr Set data model.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_domHelper</span>
        : <span class="type">goog.dom.DomHelper=</span>
        <div class="entryOverview">Optional DOM helper, used for
    document interaction.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="class_goog_ui_media_Media.html">goog.ui.media.Media</a></span>&nbsp;
            A Control binded to the FlickrSet renderer.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_media_flickr.js.source.html#line135">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.media.FlickrSetModel.newInstance"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.media.FlickrSetModel.</span><span class="entryName">newInstance<span class="args">(<span class="arg">flickrSetUrl</span>,&nbsp;<span class="arg">opt_caption</span>,&nbsp;<span class="arg">opt_description</span>)</span>
        </span>
        &#8658; <span class="type"><a href="class_goog_ui_media_FlickrSetModel.html">goog.ui.media.FlickrSetModel</a></span>
      </div>


     <div class="entryOverview">
       Takes a <code> flickrSetUrl</code> and extracts the flickr username and set id.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">flickrSetUrl</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">A Flickr set URL.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_caption</span>
        : <span class="type">string=</span>
        <div class="entryOverview">An optional caption of the flickr set.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_description</span>
        : <span class="type">string=</span>
        <div class="entryOverview">An optional description of the flickr set.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="class_goog_ui_media_FlickrSetModel.html">goog.ui.media.FlickrSetModel</a></span>&nbsp;
            The data model that represents the
    Flickr set.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_media_flickr.js.source.html#line271">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.media.FlickrSet.setFlashUrl"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.media.FlickrSet.</span><span class="entryName">setFlashUrl<span class="args">(<span class="arg">flashUrl</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       A static method that sets which flash URL this class should use. Use this if
you want to host your own flash flickr player.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">flashUrl</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">The URL of the flash flickr player.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_media_flickr.js.source.html#line149">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>






      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Directory media</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">File Reference</h2>
            <div id="sideFileIndex" rootPath="" current="/goog/ui/media/flickr.js"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
